<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Alexa Auto SDK: aace::apl::APL Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="aace-logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Alexa Auto SDK
   &#160;<span id="projectnumber">2.2.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>aace</b></li><li class="navelem"><b>apl</b></li><li class="navelem"><a class="el" href="classaace_1_1apl_1_1_a_p_l.html">APL</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classaace_1_1apl_1_1_a_p_l-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">aace::apl::APL Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a97bcf6e8f7709626c6e5f9b2b06861ef"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaace_1_1apl_1_1_a_p_l.html#a97bcf6e8f7709626c6e5f9b2b06861ef">getVisualContext</a> ()=0</td></tr>
<tr class="separator:a97bcf6e8f7709626c6e5f9b2b06861ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a605da3ae66ca91baa83f71442e0c4273"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaace_1_1apl_1_1_a_p_l.html#a605da3ae66ca91baa83f71442e0c4273">renderDocument</a> (const std::string &amp;jsonPayload, const std::string &amp;token, const std::string &amp;windowId)=0</td></tr>
<tr class="separator:a605da3ae66ca91baa83f71442e0c4273"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9659ffea560f0be933c506a0bba2de13"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaace_1_1apl_1_1_a_p_l.html#a9659ffea560f0be933c506a0bba2de13">clearDocument</a> ()=0</td></tr>
<tr class="separator:a9659ffea560f0be933c506a0bba2de13"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a14091f7b0a6e8898098d04ec67abac8c"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaace_1_1apl_1_1_a_p_l.html#a14091f7b0a6e8898098d04ec67abac8c">executeCommands</a> (const std::string &amp;jsonPayload, const std::string &amp;token)=0</td></tr>
<tr class="separator:a14091f7b0a6e8898098d04ec67abac8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe1e559640f83434304f1b2b826fda62"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaace_1_1apl_1_1_a_p_l.html#abe1e559640f83434304f1b2b826fda62">interruptCommandSequence</a> ()=0</td></tr>
<tr class="separator:abe1e559640f83434304f1b2b826fda62"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6831186c4572d71e2094271563c1a805"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaace_1_1apl_1_1_a_p_l.html#a6831186c4572d71e2094271563c1a805">clearCard</a> ()</td></tr>
<tr class="separator:a6831186c4572d71e2094271563c1a805"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ea358a32c50da5fbe733bb370e640a2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaace_1_1apl_1_1_a_p_l.html#a7ea358a32c50da5fbe733bb370e640a2">clearAllExecuteCommands</a> ()</td></tr>
<tr class="separator:a7ea358a32c50da5fbe733bb370e640a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a650185d2e461fa04a54ca6389cea9b7e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaace_1_1apl_1_1_a_p_l.html#a650185d2e461fa04a54ca6389cea9b7e">sendUserEvent</a> (const std::string &amp;payload)</td></tr>
<tr class="separator:a650185d2e461fa04a54ca6389cea9b7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae78b5ed9cf53ac882d12bdff99d69638"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaace_1_1apl_1_1_a_p_l.html#ae78b5ed9cf53ac882d12bdff99d69638">setAPLMaxVersion</a> (const std::string &amp;aplMaxVersion)</td></tr>
<tr class="separator:ae78b5ed9cf53ac882d12bdff99d69638"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad6270378b772440b1d4679b844d4d928"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaace_1_1apl_1_1_a_p_l.html#ad6270378b772440b1d4679b844d4d928">setDocumentIdleTimeout</a> (std::chrono::milliseconds documentIdleTimeout)</td></tr>
<tr class="separator:ad6270378b772440b1d4679b844d4d928"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a42ad9effa8cb1ae3ca95fa65c3378993"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaace_1_1apl_1_1_a_p_l.html#a42ad9effa8cb1ae3ca95fa65c3378993">renderDocumentResult</a> (const std::string &amp;token, const bool result, const std::string &amp;error)</td></tr>
<tr class="separator:a42ad9effa8cb1ae3ca95fa65c3378993"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3599f0eec806b4e0d1315ca1f1e8d1b1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaace_1_1apl_1_1_a_p_l.html#a3599f0eec806b4e0d1315ca1f1e8d1b1">executeCommandsResult</a> (const std::string &amp;token, const bool result, const std::string &amp;error)</td></tr>
<tr class="separator:a3599f0eec806b4e0d1315ca1f1e8d1b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e382051d18bc09a39e1f3cd9b9ddb9a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaace_1_1apl_1_1_a_p_l.html#a1e382051d18bc09a39e1f3cd9b9ddb9a">processActivityEvent</a> (const std::string &amp;source, const ActivityEvent event)</td></tr>
<tr class="separator:a1e382051d18bc09a39e1f3cd9b9ddb9a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classaace_1_1apl_1_1_a_p_l.html">APL</a> should be extended to handle receiving Alexa Presentation <code>RenderDocument</code> and <code>ExecuteCommands</code> directives from AVS. These directives contain metadata for rendering or operating on display cards for devices with GUI support. For more information about Alexa Presentation Language (<a class="el" href="classaace_1_1apl_1_1_a_p_l.html">APL</a>) see the interface overview: <a href="https://developer.amazon.com/en-US/docs/alexa/alexa-presentation-language/understand-apl.html">https://developer.amazon.com/en-US/docs/alexa/alexa-presentation-language/understand-apl.html</a> </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a97bcf6e8f7709626c6e5f9b2b06861ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a97bcf6e8f7709626c6e5f9b2b06861ef">&#9670;&nbsp;</a></span>getVisualContext()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual std::string aace::apl::APL::getVisualContext </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Retrieve the visual context from the platform implementation.</p>
<dl class="section return"><dt>Returns</dt><dd>the current VisualContext payload. </dd></dl>

</div>
</div>
<a id="a605da3ae66ca91baa83f71442e0c4273"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a605da3ae66ca91baa83f71442e0c4273">&#9670;&nbsp;</a></span>renderDocument()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void aace::apl::APL::renderDocument </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>jsonPayload</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>token</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>windowId</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Notifies the platform implementation that a <code>RenderDocument</code> directive has been received. Once called, the client should render the document based on the <a class="el" href="classaace_1_1apl_1_1_a_p_l.html">APL</a> specification in the payload in structured JSON format.</p>
<dl class="section note"><dt>Note</dt><dd>The payload may contain customer sensitive information and should be used with utmost care. Failure to do so may result in exposing or mishandling of customer data.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">jsonPayload</td><td>The payload of the Alexa.Presentation.APL.RenderDocument directive which follows the <a class="el" href="classaace_1_1apl_1_1_a_p_l.html">APL</a> specification. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">token</td><td>The <a class="el" href="classaace_1_1apl_1_1_a_p_l.html">APL</a> presentation token associated with this payload. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">windowId</td><td>The target windowId. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a9659ffea560f0be933c506a0bba2de13"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9659ffea560f0be933c506a0bba2de13">&#9670;&nbsp;</a></span>clearDocument()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void aace::apl::APL::clearDocument </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Notifies the platform implementation when the client should clear the <a class="el" href="classaace_1_1apl_1_1_a_p_l.html">APL</a> display card. Once the card is cleared, the platform implementation should call <a class="el" href="classaace_1_1apl_1_1_a_p_l.html#a6831186c4572d71e2094271563c1a805">clearCard()</a>. </p>

</div>
</div>
<a id="a14091f7b0a6e8898098d04ec67abac8c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a14091f7b0a6e8898098d04ec67abac8c">&#9670;&nbsp;</a></span>executeCommands()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void aace::apl::APL::executeCommands </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>jsonPayload</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>token</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Notifies the platform implementation that an ExecuteCommands directive has been received.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">jsonPayload</td><td>The payload of the Alexa.Presentation.APL.ExecuteCommands directive in structured JSON format. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">token</td><td>Directive token used to bind result processing. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="abe1e559640f83434304f1b2b826fda62"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe1e559640f83434304f1b2b826fda62">&#9670;&nbsp;</a></span>interruptCommandSequence()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void aace::apl::APL::interruptCommandSequence </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Notifies the platform implementation that a command execution sequence should be interrupted. </p>

</div>
</div>
<a id="a6831186c4572d71e2094271563c1a805"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6831186c4572d71e2094271563c1a805">&#9670;&nbsp;</a></span>clearCard()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void aace::apl::APL::clearCard </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Notifies the Engine to clear the card from the screen and release any focus being held. </p>

</div>
</div>
<a id="a7ea358a32c50da5fbe733bb370e640a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ea358a32c50da5fbe733bb370e640a2">&#9670;&nbsp;</a></span>clearAllExecuteCommands()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void aace::apl::APL::clearAllExecuteCommands </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Notifies the Engine to clear all pending ExecuteCommands directives and mark them as failed. </p>

</div>
</div>
<a id="a650185d2e461fa04a54ca6389cea9b7e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a650185d2e461fa04a54ca6389cea9b7e">&#9670;&nbsp;</a></span>sendUserEvent()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void aace::apl::APL::sendUserEvent </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>payload</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Notifies the Engine to send <code>UserEvent</code> to AVS.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">payload</td><td>The <code>UserEvent</code> event payload. The caller of this function is responsible to pass the payload as it defined by AVS. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ae78b5ed9cf53ac882d12bdff99d69638"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae78b5ed9cf53ac882d12bdff99d69638">&#9670;&nbsp;</a></span>setAPLMaxVersion()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void aace::apl::APL::setAPLMaxVersion </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>aplMaxVersion</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Set the <a class="el" href="classaace_1_1apl_1_1_a_p_l.html">APL</a> version supported by the runtime component.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">aplMaxVersion</td><td>The <a class="el" href="classaace_1_1apl_1_1_a_p_l.html">APL</a> version supported. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ad6270378b772440b1d4679b844d4d928"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad6270378b772440b1d4679b844d4d928">&#9670;&nbsp;</a></span>setDocumentIdleTimeout()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void aace::apl::APL::setDocumentIdleTimeout </td>
          <td>(</td>
          <td class="paramtype">std::chrono::milliseconds&#160;</td>
          <td class="paramname"><em>documentIdleTimeout</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Set a custom document idle timeout.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">documentIdleTimeout</td><td>The timeout in milliseconds. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>Will be reset for every directive received from AVS. </dd></dl>

</div>
</div>
<a id="a42ad9effa8cb1ae3ca95fa65c3378993"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a42ad9effa8cb1ae3ca95fa65c3378993">&#9670;&nbsp;</a></span>renderDocumentResult()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void aace::apl::APL::renderDocumentResult </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>token</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const bool&#160;</td>
          <td class="paramname"><em>result</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>error</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Notifies the Engine with the result of a <code>renderDocument</code> notification.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">token</td><td>The document presentation token. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">result</td><td>Rendering result (true on executed, false on exception). </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">error</td><td>Error message provided in case result is false. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a3599f0eec806b4e0d1315ca1f1e8d1b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3599f0eec806b4e0d1315ca1f1e8d1b1">&#9670;&nbsp;</a></span>executeCommandsResult()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void aace::apl::APL::executeCommandsResult </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>token</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const bool&#160;</td>
          <td class="paramname"><em>result</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>error</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Notifies the Engine with the result of an <code>executeCommands</code> notification.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">token</td><td>The document presentation token. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">result</td><td>Rendering result (true on executed, false on exception). </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">error</td><td>Error message provided in case result is false. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a1e382051d18bc09a39e1f3cd9b9ddb9a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e382051d18bc09a39e1f3cd9b9ddb9a">&#9670;&nbsp;</a></span>processActivityEvent()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void aace::apl::APL::processActivityEvent </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>source</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const ActivityEvent&#160;</td>
          <td class="paramname"><em>event</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Notifies the Engine of an activity change event.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">source</td><td>The source of the activity event. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">event</td><td>The activity change event. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div><!-- contents -->
<html>
  <body>
    <hr style="height:1px;border-width:0;color:gray;background-color:gray">
    <p style="text-align:left;">
      Alexa Auto SDK 2.2.0 - Copyright 2017-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
      <span style="float:right;">
        Licensed under the <a HREF=http://aws.amazon.com/apache2.0/>Apache License, Version 2.0</a>
      </span>
    </p>
  </body>
</html>
